home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / cycleclass.doc < prev    next >
Encoding:
Text File  |  1994-08-20  |  2.7 KB  |  85 lines
  1.  
  2.            $RCSfile: cycleclass.doc,v $
  3.         Description: Cycleclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.3 $
  10.               $Date: 1994/08/19 17:01:24 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. cycleclass/--background--
  16. cycleclass/Methods
  17. cycleclass/Attributes
  18.  
  19. cycleclass/--background--                            cycleclass/--background--
  20.  
  21.     NAME
  22.         Class:          cycleclass
  23.         Superclass:     baseclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a gadget simular to the gadtools.library it's cycle kind.
  28.         Objects from  this  class  will  send the following  attributes  pairs
  29.         in it's notification events:
  30.  
  31.         GA_ID           - Gadget object ID.
  32.         CYC_Active      - Gadget object active label number.
  33.  
  34. cycleclass/Methods                                          cycleclass/Methods
  35.  
  36.     NEW METHODS
  37.         None.
  38.  
  39.     CHANGED METHODS
  40.         None.
  41.  
  42. cycleclass/Attributes                                    cycleclass/Attributes
  43.  
  44.     NAME
  45.         CYC_Labels -- ( STRPTR * )
  46.  
  47.     FUNCTION
  48.         Set an array of string pointers which will be the cycle gadget labels.
  49.         The  array  must  point to a valid NULL-terminated array or the object
  50.         will fail to create.
  51.  
  52.         Default is NULL. Applicability is (I).
  53.  
  54.     NAME
  55.         CYC_Active -- ( ULONG )
  56.  
  57.     FUNCTION
  58.         Set  or  get  the  number of the currently active label where 0 is the
  59.         first label in the array.
  60.  
  61.         Default is 0. Applicability is (ISGNU).
  62.  
  63.     NAME
  64.         CYC_Popup -- ( BOOL )
  65.  
  66.     FUNCTION
  67.         To make  the  cycle object into a popup menu. When this is set to TRUE
  68.         and you click inside the label area of the cycle gadget a menu appears
  69.         in which all choises are visible. Selecting the wanted item is simular
  70.         to normal  menu-selection. Pressing the right mouse-button will cancel
  71.         the selection.
  72.  
  73.         When this  option  is  on  and you press inside the cycle-image of the
  74.         object the old selection method is used.
  75.  
  76.         Please note  that  when  the  popup  option is turned on and the cycle
  77.         object has  more  entries  than  can be made visible on the screen the
  78.         list will be truncated.
  79.  
  80.         On OS  3.0  systems  or  better  (V39++)  the menu will always use the
  81.         NewLook-menu coloring.  On  systems running less than OS 3.0 the menus
  82.         will appear in the BlockPen and DetailPen.
  83.  
  84.         Default is FALSE. Applicability is (I).
  85.